home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cato / Xm / XmClipboardRegisterFormat.z / XmClipboardRegisterFormat
Text File  |  1998-10-20  |  6KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeeggggiiiisssstttteeeerrrrFFFFoooorrrrmmmmaaaatttt((((3333UUUUXXXXNNNN))))IIIIXXXX SSSSyyyysssstttteeeemmmmXXXXmmmmVVVVCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeeggggiiiisssstttteeeerrrrFFFFoooorrrrmmmmaaaatttt((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeeggggiiiisssstttteeeerrrrFFFFoooorrrrmmmmaaaatttt - A clipboard function that
  10.           registers a new format
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////XXXXmmmm....hhhh>>>>
  14.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////CCCCuuuuttttPPPPaaaasssstttteeee....hhhh>>>>
  15.  
  16.           iiiinnnntttt XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeeggggiiiisssstttteeeerrrrFFFFoooorrrrmmmmaaaatttt ((((_d_i_s_p_l_a_y, _f_o_r_m_a_t__n_a_m_e, _f_o_r_m_a_t__l_e_n_g_t_h))))
  17.                DDDDiiiissssppppllllaaaayyyy     * _d_i_s_p_l_a_y;;;;
  18.                cccchhhhaaaarrrr        * _f_o_r_m_a_t__n_a_m_e;;;;
  19.                iiiinnnntttt         _f_o_r_m_a_t__l_e_n_g_t_h;;;;
  20.  
  21.  
  22.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  23.           This page documents version 1.2 of the Motif library.
  24.  
  25.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeeggggiiiisssstttteeeerrrrFFFFoooorrrrmmmmaaaatttt registers a new format.  Each
  27.           format stored on the clipboard should have a length
  28.           associated with it; this length must be known to the
  29.           clipboard routines.  Formats are known as targets in the
  30.           _I_n_t_e_r-_C_l_i_e_n_t _C_o_m_m_u_n_i_c_a_t_i_o_n _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l (ICCCM).  All
  31.           of the formats specified by the ICCCM conventions are
  32.           preregistered.  Any other format that the application wants
  33.           to use must either be 8-bit data or be registered via this
  34.           routine.  Failure to register the length of the data results
  35.           in incompatible applications across platforms having
  36.           different byte-swapping orders.
  37.  
  38.  
  39.           _d_i_s_p_l_a_y        Specifies a pointer to the DDDDiiiissssppppllllaaaayyyy structure
  40.                          that was returned in a previous call to
  41.                          XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy or XXXXttttDDDDiiiissssppppllllaaaayyyy.
  42.  
  43.           _f_o_r_m_a_t__n_a_m_e    Specifies the string name for the new format
  44.                          (target).
  45.  
  46.           _f_o_r_m_a_t__l_e_n_g_t_h  Specifies the format length in bits (8, 16,
  47.                          or 32).
  48.  
  49.  
  50.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  51.           CCCClllliiiippppbbbbooooaaaarrrrddddBBBBaaaaddddFFFFoooorrrrmmmmaaaatttt
  52.                          The _f_o_r_m_a_t__n_a_m_e must not be NULL, and the
  53.                          _f_o_r_m_a_t__l_e_n_g_t_h must be 8, 16, or 32.
  54.  
  55.           CCCClllliiiippppbbbbooooaaaarrrrddddSSSSuuuucccccccceeeessssssss
  56.                          The function is successful.
  57.  
  58.           CCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkkeeeedddd
  59.                          The function failed because the clipboard was
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeeggggiiiisssstttteeeerrrrFFFFoooorrrrmmmmaaaatttt((((3333UUUUXXXXNNNN))))IIIIXXXX SSSSyyyysssstttteeeemmmmXXXXmmmmVVVVCCCClllliiiippppbbbbooooaaaarrrrddddRRRReeeeggggiiiisssstttteeeerrrrFFFFoooorrrrmmmmaaaatttt((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                          locked by another application.  The
  75.                          application can continue to call the function
  76.                          again with the same parameters until the lock
  77.                          goes away.  This gives the application the
  78.                          opportunity to ask if the user wants to keep
  79.                          trying or to give up on the operation.
  80.  
  81.           CCCClllliiiippppbbbbooooaaaarrrrddddFFFFaaaaiiiillll  The function failed because the format was
  82.                          already registered with this length.
  83.  
  84.  
  85.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  86.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy((((3333XXXX)))).
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.